<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>aws-crt-cpp: Aws::Crt::Auth::ICredentialsProvider Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">aws-crt-cpp
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceAws.html">Aws</a></li><li class="navelem"><a class="el" href="namespaceAws_1_1Crt.html">Crt</a></li><li class="navelem"><a class="el" href="namespaceAws_1_1Crt_1_1Auth.html">Auth</a></li><li class="navelem"><a class="el" href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.html">ICredentialsProvider</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Aws::Crt::Auth::ICredentialsProvider Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="Credentials_8h_source.html">Credentials.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Aws::Crt::Auth::ICredentialsProvider:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.png" usemap="#Aws::Crt::Auth::ICredentialsProvider_map" alt=""/>
  <map id="Aws::Crt::Auth::ICredentialsProvider_map" name="Aws::Crt::Auth::ICredentialsProvider_map">
<area href="classAws_1_1Crt_1_1Auth_1_1CredentialsProvider.html" alt="Aws::Crt::Auth::CredentialsProvider" shape="rect" coords="0,112,316,136"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aefe60b9490b1de1628177fae79012237"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.html#aefe60b9490b1de1628177fae79012237">~ICredentialsProvider</a> ()=default</td></tr>
<tr class="separator:aefe60b9490b1de1628177fae79012237"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15ee87754babd9d866d6bb25cd2951d8"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.html#a15ee87754babd9d866d6bb25cd2951d8">GetCredentials</a> (const <a class="el" href="namespaceAws_1_1Crt_1_1Auth.html#a264e6cff99e2c2872d62a4a85c825ca8">OnCredentialsResolved</a> &amp;onCredentialsResolved) const =0</td></tr>
<tr class="separator:a15ee87754babd9d866d6bb25cd2951d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08fa433e05ce03f14051d666d1c32d43"><td class="memItemLeft" align="right" valign="top">virtual aws_credentials_provider *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.html#a08fa433e05ce03f14051d666d1c32d43">GetUnderlyingHandle</a> () const noexcept=0</td></tr>
<tr class="separator:a08fa433e05ce03f14051d666d1c32d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19d7f5ea0891ca2c95334d5a40bdbd88"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAws_1_1Crt_1_1Auth_1_1ICredentialsProvider.html#a19d7f5ea0891ca2c95334d5a40bdbd88">IsValid</a> () const noexcept=0</td></tr>
<tr class="separator:a19d7f5ea0891ca2c95334d5a40bdbd88"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base interface for all credentials providers. <a class="el" href="classAws_1_1Crt_1_1Auth_1_1Credentials.html">Credentials</a> providers are objects that retrieve AWS credentials from some source. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aefe60b9490b1de1628177fae79012237"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefe60b9490b1de1628177fae79012237">&#9670;&nbsp;</a></span>~ICredentialsProvider()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual Aws::Crt::Auth::ICredentialsProvider::~ICredentialsProvider </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a15ee87754babd9d866d6bb25cd2951d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15ee87754babd9d866d6bb25cd2951d8">&#9670;&nbsp;</a></span>GetCredentials()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Aws::Crt::Auth::ICredentialsProvider::GetCredentials </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceAws_1_1Crt_1_1Auth.html#a264e6cff99e2c2872d62a4a85c825ca8">OnCredentialsResolved</a> &amp;&#160;</td>
          <td class="paramname"><em>onCredentialsResolved</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Asynchronous method to query for AWS credentials based on the internal provider implementation. </p>

<p>Implemented in <a class="el" href="classAws_1_1Crt_1_1Auth_1_1CredentialsProvider.html#a58acb95b7184d9cb4fb9f211f80cb441">Aws::Crt::Auth::CredentialsProvider</a>.</p>

</div>
</div>
<a id="a08fa433e05ce03f14051d666d1c32d43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08fa433e05ce03f14051d666d1c32d43">&#9670;&nbsp;</a></span>GetUnderlyingHandle()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual aws_credentials_provider* Aws::Crt::Auth::ICredentialsProvider::GetUnderlyingHandle </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns the underlying credentials provider implementation. Support for credentials providers not based on a C implementation is theoretically possible, but requires some re-implementation to support provider chains and caching (whose implementations rely on links to C implementation providers) </p>

<p>Implemented in <a class="el" href="classAws_1_1Crt_1_1Auth_1_1CredentialsProvider.html#a861f140ae670ae824546ea09af3a0ff8">Aws::Crt::Auth::CredentialsProvider</a>.</p>

</div>
</div>
<a id="a19d7f5ea0891ca2c95334d5a40bdbd88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19d7f5ea0891ca2c95334d5a40bdbd88">&#9670;&nbsp;</a></span>IsValid()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Aws::Crt::Auth::ICredentialsProvider::IsValid </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Validity check method </p>

<p>Implemented in <a class="el" href="classAws_1_1Crt_1_1Auth_1_1CredentialsProvider.html#a8294aff49261f8a75f428eee8c693812">Aws::Crt::Auth::CredentialsProvider</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/ANT.AMAZON.COM/dengket/doc/aws-crt-cpp/include/aws/crt/auth/<a class="el" href="Credentials_8h_source.html">Credentials.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>
